home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / telecomm / fnordadl / fn132src.zoo / ctdlcnfg.doc next >
Text File  |  1991-09-02  |  38KB  |  782 lines
  1. *----------------------------------------------------------------------------*
  2. * CTDLCNFG.SYS -- Fnordadel v1.32 configuration file.
  3. *----------------------------------------------------------------------------*
  4. * Fnordadel is maintained by Adrian Ashley (elim @ secret) and Royce
  5. * Howland (Mr. Neutron @ RT); any errors in this document are mostly our
  6. * fault.  Portions of the text of this file borrowed with thanks from
  7. * ctdlcnfg.sys & ctdlcnfg.doc by orc.
  8. *----------------------------------------------------------------------------*
  9. * To bring up your system, edit this file to suit your tastes, and then
  10. * run configur.tos on it.  Configur will create all the system files that
  11. * Fnordadel needs.  Then run citadel.tos, and you're off!
  12. *
  13. * The only valid lines in ctdlcnfg.sys are ones that begin with '#'.  Anything
  14. * else is assumed to be a comment.  Valid lines are of two types:
  15. *
  16. *   1) #define <variable> <value>
  17. *   2) #<variable> <value>
  18. *
  19. * Form (1) is used to set numeric values, like `#define logsize 100'.  Note
  20. * that many of these variables are switches; that is, they may only take the
  21. * value 0 or 1.  (Actually, any nonzero number is equivalent to 1 in this
  22. * context, but let's keep it simple.)
  23. *
  24. * Form (2) is usually used to set string variables.  Which leads us to...
  25. *
  26. * String Fields:  The following fields are strings, and must be enclosed in
  27. * quotes.  They allow some C-type escape characters in them: '\r' for <CR>,
  28. * '\n' for newline (CR + LF), \nnn for the ASCII character represented by the
  29. * octal number 'nnn', and '\\' for a single '\'.
  30. *
  31. *       #reply300    #nodetitle    #calloutprefix
  32. *       #reply1200    #baseroom    #calloutsuffix
  33. *       #reply2400    #basefloor    #modemsetup
  34. *       #reply9600                 ^
  35. *       #reply19200                 +-----<Modem control strings>
  36. *
  37. * The modem control strings have an additional special escape in them.
  38. * Any `%nnn' sequence will make Fnordadel pause for `nnn' tenths of a
  39. * second before continuing.  For instance,
  40. *
  41. *     #modemsetup "AT\r%10AT S0=1 M1 E0 Q0 X1\r%10"
  42. *
  43. * will send AT\r to the modem, wait one second, send AT S0=1 M1 E0 Q0 X1\r to
  44. * the modem, then wait another second.
  45. *
  46. * NOTE: All numbers in this file should be decimal, as opposed to hexadecimal
  47. * or octal.
  48. *
  49. *----------------------------------------------------------------------------*
  50.  
  51. #nodetitle "Secret Service: Best in the West!"
  52.  
  53. * #nodetitle is what Fnordadel uses in the .RS command ("This is ....");
  54. * and if you haven't got a banner.blb in your help directory, it uses this
  55. * field to identify your system to callers.  This field must be defined.
  56.  
  57. #nodename "secret"            * 19 chars max. (try to keep under 9)
  58. #nodeid "CA (403) 425-1779"        * 19 characters max.
  59. #organization "Fnordadel Development"    * 39 characters max.
  60. #domain "Alta"                * 19 chars max. (usually 2 chars)
  61.  
  62. * #nodename is the short name Fnordadel uses for your system in networking.
  63. * Messages from your system will be from "user@<nodename>".
  64. *
  65. * #nodeid is the phone number of your system. Users will never see
  66. * this field. The node id should be in the form `XX (NNN) NNN-NNNN'
  67. *                                                ^    ^    ^
  68. *     country (CA = Canada, US = United States) -+    |    |
  69. *         area code (for North American number) ------+    |
  70. *                                  local number -----------+
  71. *
  72. * #organization is used to identify your system somewhat more descriptively
  73. * than #nodename does.  It can say anything, really -- what your system is
  74. * for, where it is located, who you want to win the Stanley Cup -- anything.
  75. * The field will appear so: "...from user @ nodename (organization)"
  76. *
  77. * #domain sets your system's domain.  A domain is an arbitrary collection of
  78. * networking systems.  Usually, domains are based on geographical regions of
  79. * some kind, but they could be based on anything at all.  The Citadel net
  80. * uses state or province as the domain base.  If there is no domain for your
  81. * state or province yet, you can either start one yourself or join the domain
  82. * of another region.
  83.  
  84. #baseroom "Lobby"            * 19 characters max.
  85. #basefloor "Ground Floor"        * 19 characters max.
  86.  
  87. * #baseroom tells Fnordadel what you want the first room in the system
  88. * (usually called 'Lobby') to be called.  It defaults to Lobby if you don't
  89. * define this field.
  90. * 
  91. * #basefloor is used to define what the first floor will be called.  It, too,
  92. * defaults to Lobby, or to the same name as #baseroom if #basefloor is
  93. * left undefined.
  94.  
  95. #syspassword "d:\blort\foo.bar"
  96.  
  97. * The sysop password allows access from remote to the sysop menu.
  98. * #syspassword is the name of a file, the first line of which is the actual
  99. * sysop password.  For example, if you have #syspassword "\sys\password.dat",
  100. * and the first line of that file says "Supercalifragilisticexpialidocious",
  101. * then "Super<etc>..." becomes the sysop password.  The password must be at
  102. * least 15 characters long.
  103.  
  104. #sysop "elim"
  105. #define archive-mail 1
  106.  
  107. * This defines who the sysop is.  Any mail sent to "Sysop" will be sent to
  108. * this user instead.  If #sysop is not defined, mail to "Sysop" ends up in the
  109. * Aide> room.  When the user named in this field first logs in, he/she will be
  110. * automagically given Aide, Network and Sysop privileges -- so DON'T define
  111. * this field and then forget about logging in as the named user!
  112. *
  113. * `archive-mail' allows the sysop to have all of his/her Mail> (both To and
  114. * From the Sysop) saved to a diskfile, specifically `sysop.msg' in your
  115. * #auditdir.  Set `archive-mail' to 1 to enable this feature.  Note that
  116. * #sysop should be defined to use this properly, though it doesn't need to be.
  117.  
  118. #shell "c:\bin\command.tos"
  119.  
  120. * #shell is the command line interpreter (shell) invoked by the [O]utside
  121. * command in the sysop menu.  If you're using doors and have one called
  122. * `shell', it will override #shell.
  123.  
  124. #define logsize        100
  125. #define messagek    128
  126. #define cryptseed    069
  127.  
  128. * `logsize', `cryptseed', and `messagek' are all essential and MUST be defined.
  129. *
  130. * `logsize' says how many userlog entries you want your BBS to have.  This
  131. * number is fixed when you first configure the system; it can only be changed
  132. * by running lchange.tos.  Each userlog entry consumes about 0.5k (512 bytes),
  133. * give or take a few.
  134. *
  135. * `messagek' says how large you want your messagebase to be, in kilobytes.
  136. * Configur will round this number up to the next multiple of 4.  Err on the
  137. * side of caution, if at all -- expanding the message base is easier than
  138. * shrinking it, although both are possible using mexpand.tos and mshrink.tos
  139. * respectively.
  140. *
  141. * `cryptseed' is a magic number used by Fnordadel to encrypt all of its
  142. * system files (to hide them from prying eyes).  DO NOT change this number
  143. * after you've first configured your system; if you do, all Heg will break
  144. * loose.
  145.  
  146. #define maxrooms    64
  147. #define mailslots    58
  148. #define sharedrooms    16
  149.  
  150. * `maxrooms', `mailslots' and `sharedrooms' are also all essential and MUST
  151. * be defined.
  152. *
  153. * `maxrooms' is the maximum number of rooms that may be present on your
  154. * system.  The historical limit has been 64, though you are free to change it.
  155. * Note that each room takes a minimum of 1k on disk, as each room is stored
  156. * in a separate disk file.  Try to estimate the number of rooms you'll need;
  157. * you can add more later (see rchange.man).
  158. *
  159. * `mailslots' refers to the maximum number of messages accessible to users
  160. * (at any one time) in the Mail> room.  This value will affect the size of
  161. * the userlog; each additional mailslot takes (6 * logsize) bytes in the log
  162. * file (see mchange.man).
  163. *
  164. * `sharedrooms' is the maximum number of rooms that may be shared (networked)
  165. * with any given network system.  The historical limit is 16; if you have a
  166. * lot of networked rooms, you may want to raise this (see nchange.man).
  167.  
  168. #msgdir   "c:\sys"
  169. #sysdir   "c:\sys"
  170. #roomdir  "c:\rooms"
  171. #helpdir  "c:\help"
  172. #auditdir "c:\audit"
  173.  
  174. * These fields MUST be defined.  They are the names of directories where
  175. * Fnordadel will store its various datafiles.
  176. *     #msgdir is where the messagebase lives (ctdlmsg.sys);
  177. *     #sysdir is where the floor, userlog, and other system files live;
  178. *     #roomdir is where the room files live;
  179. *     #helpdir is